/*
 * Copyright 2010 Chad Retz
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package org.jdocng.parse.qdox.function;

import org.jdocng.parse.qdox.QDoxContext;
import org.jdocng.parse.qdox.QDoxUtils;
import org.jdocng.shared.model.ParamTagImpl;

import com.thoughtworks.qdox.model.DocletTag;

/**
 * Construct {@link ParamTagImpl} from {@link DocletTag}
 *
 * @author Chad Retz
 */
public class ParamTagFunction extends TagFunction<ParamTagImpl> {

    private static final ParamTagFunction instance = new ParamTagFunction();

    public static ParamTagFunction getInstance() {
        return instance;
    }

    protected ParamTagFunction() {
    }

    @Override
    public ParamTagImpl apply(QDoxContext context, DocletTag from) {
        ParamTagImpl to = new ParamTagImpl();
        apply(context, from, to);
        return to;
    }

    @Override
    public void apply(QDoxContext context, DocletTag from, ParamTagImpl to) {
        super.apply(context, from, to);
        to.setKind("@param");
        String contents = from.getValue().trim();
        String firstWord = TagFunction.getFirstWord(contents);
        contents = contents.substring(0, firstWord.length()).trim();
        if (firstWord.charAt(0) == '<') {
            // TODO is this enough to determine type parameters?
            to.setTypeParameter(true);
            firstWord = firstWord.substring(0, firstWord.length() - 1);
            if (!QDoxUtils.containsTypeParameter(from.getContext(), firstWord)) {
                QDoxUtils.log(context, from.getContext(), from.getLineNumber(),
                        "warn.parse.no_type_param", firstWord);
            }
        } else {
            to.setTypeParameter(false);
            if (!QDoxUtils.containsParameter(from.getContext(), firstWord)) {
                QDoxUtils.log(context, from.getContext(), from.getLineNumber(),
                        "warn.parse.no_param", firstWord);
            }
        }
        to.setParameterName(firstWord);
        to.setParameterComment(contents);
    }

}
